6 class AutoLoaderStructureTest
extends MediaWikiTestCase
{
8 * Assert that there were no classes loaded that are not registered with the AutoLoader.
10 * For example foo.php having class Foo and class Bar but only registering Foo.
11 * This is important because we should not be relying on Foo being used before Bar.
13 public function testAutoLoadConfig() {
14 $results = self
::checkAutoLoadConf();
22 public function providePSR4Completeness() {
23 foreach ( AutoLoader
::$psr4Namespaces as $prefix => $dir ) {
24 foreach ( $this->recurseFiles( $dir ) as $file ) {
25 yield
[ $prefix, $dir, $file ];
30 private function recurseFiles( $dir ) {
31 return ( new File_Iterator_Facade() )->getFilesAsArray( $dir, [ '.php' ] );
35 * @dataProvider providePSR4Completeness
37 public function testPSR4Completeness( $prefix, $dir, $file ) {
38 global $wgAutoloadLocalClasses, $wgAutoloadClasses;
39 $contents = file_get_contents( $file );
40 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
41 $classes = array_keys( $classesInFile );
43 $this->assertCount( 1, $classes,
44 "Only one class per file in PSR-4 autoloaded classes ($file)" );
46 // Check that the expected class name (based on the filename) is the
47 // same as the one we found.
48 // Strip directory prefix from front of filename, and .php extension
49 $abbrFileName = substr( substr( $file, strlen( $dir ) ), 0, -4 );
50 $expectedClassName = $prefix . str_replace( '/', '\\', $abbrFileName );
55 "Class not autoloaded properly"
59 // Dummy assertion so this test isn't marked in risky
60 // if the file has no classes nor aliases in it
61 $this->assertCount( 0, $classes );
64 if ( $aliasesInFile ) {
65 $otherClasses = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
66 foreach ( $aliasesInFile as $alias => $class ) {
67 $this->assertArrayHasKey( $alias, $otherClasses,
68 'Alias must be in the classmap autoloader'
74 private static function parseFile( $contents ) {
75 // We could use token_get_all() here, but this is faster
76 // Note: Keep in sync with ClassCollector
80 (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
81 (?P<class> [a-zA-Z0-9_]+)
83 class_alias \s* \( \s*
84 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
85 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
88 class_alias \s* \( \s*
89 (?P<originalStatic> [a-zA-Z0-9_]+)::class \s* , \s*
90 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
93 /imx', $contents, $matches, PREG_SET_ORDER
);
99 ([a-zA-Z0-9_]+(\\\\[a-zA-Z0-9_]+)*)
101 /imx', $contents, $namespaceMatch );
102 $fileNamespace = $namespaceMatch ?
$namespaceMatch[1] . '\\' : '';
107 foreach ( $matches as $match ) {
108 if ( !empty( $match['class'] ) ) {
110 $class = $fileNamespace . $match['class'];
111 $classesInFile[$class] = true;
113 if ( !empty( $match['original'] ) ) {
114 // 'class_alias( "Foo", "Bar" );'
115 $aliasesInFile[$match['alias']] = $match['original'];
117 // 'class_alias( Foo::class, "Bar" );'
118 $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
123 return [ $classesInFile, $aliasesInFile ];
126 protected static function checkAutoLoadConf() {
127 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
129 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
130 $expected = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
133 $psr4Namespaces = [];
134 foreach ( AutoLoader
::getAutoloadNamespaces() as $ns => $path ) {
135 $psr4Namespaces[rtrim( $ns, '\\' ) . '\\'] = rtrim( $path, '/' );
138 $files = array_unique( $expected );
140 foreach ( $files as $class => $file ) {
141 // Only prefix $IP if it doesn't have it already.
142 // Generally local classes don't have it, and those from extensions and test suites do.
143 if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
144 $filePath = "$IP/$file";
149 if ( !file_exists( $filePath ) ) {
150 $actual[$class] = "[file '$filePath' does not exist]";
154 Wikimedia\
suppressWarnings();
155 $contents = file_get_contents( $filePath );
156 Wikimedia\restoreWarnings
();
158 if ( $contents === false ) {
159 $actual[$class] = "[couldn't read file '$filePath']";
163 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
165 foreach ( $classesInFile as $className => $ignore ) {
166 // Skip if it's a PSR4 class
167 $parts = explode( '\\', $className );
168 for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
169 $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
170 if ( isset( $psr4Namespaces[$ns] ) ) {
171 $expectedPath = $psr4Namespaces[$ns] . '/'
172 . implode( '/', array_slice( $parts, $i ) )
174 if ( $filePath === $expectedPath ) {
181 $actual[$className] = $file;
184 // Only accept aliases for classes in the same file, because for correct
185 // behavior, all aliases for a class must be set up when the class is loaded
186 // (see <https://bugs.php.net/bug.php?id=61422>).
187 foreach ( $aliasesInFile as $alias => $class ) {
188 if ( isset( $classesInFile[$class] ) ) {
189 $actual[$alias] = $file;
191 $actual[$alias] = "[original class not in $file]";
197 'expected' => $expected,
202 public function testAutoloadOrder() {
203 $path = realpath( __DIR__
. '/../../..' );
204 $oldAutoload = file_get_contents( $path . '/autoload.php' );
205 $generator = new AutoloadGenerator( $path, 'local' );
206 $generator->setPsr4Namespaces( AutoLoader
::getAutoloadNamespaces() );
207 $generator->initMediaWikiDefault();
208 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
210 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
211 ' output of generateLocalAutoload.php script.' );